<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>trafgen: xtrafgen_interrupt_example.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">trafgen
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xtrafgen__interrupt__example_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xtrafgen_interrupt_example.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file demonstrates how to use the xtrafgen driver on the Xilinx AXI Traffic Generator core. </p>
<p>The AXI Traffic Generator IP is designed to generate AXI4 traffic which can be used to stress different modules/ interconnect connected in the system. It has three internal RAMS: MASTER RAM, COMMAND RAM, PARAMETER RAM. MASTER RAM is used to load/store data from this memory for write/read transactions. And the commands to be issued are loaded into COMMAND and PARAMETER RAMs.</p>
<p>This example demonstrates by programming known data to Master RAM and commands to Command and Param RAM. Initiating the master logic will take the data from Master RAM (from a location) and generate data for slave transactions which will be stored in Master RAM at a different location specified by commands. The test passes when the master logic interrupt asserts and verifies for data to be same.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
----- ---- -------- -------------------------------------------------------
1.00a srt  01/25/13 First release
4.1   ms   01/23/17 Modified xil_printf statement in main function to
                    ensure that "Successfully ran" and "Failed" strings
                    are available in all examples. This is a fix for
                    CR-965028.</pre><pre></pre><hr/>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:afb79fd728f1a6cb5493de055332e83a6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtrafgen__interrupt__example_8c.html#afb79fd728f1a6cb5493de055332e83a6">XTrafGenInterruptExample</a> (<a class="el" href="struct_x_traf_gen.html">XTrafGen</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="memdesc:afb79fd728f1a6cb5493de055332e83a6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function demonstrates the usage Traffic Generator It does the following:  <a href="#afb79fd728f1a6cb5493de055332e83a6">More...</a><br /></td></tr>
<tr class="separator:afb79fd728f1a6cb5493de055332e83a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xtrafgen__interrupt__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a> ()</td></tr>
<tr class="memdesc:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main function.  <a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">More...</a><br /></td></tr>
<tr class="separator:ae66f6b31b5ad750f1fe042a706a4e3d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae66f6b31b5ad750f1fe042a706a4e3d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae66f6b31b5ad750f1fe042a706a4e3d4">&#9670;&nbsp;</a></span>main()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int main </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Main function. </p>
<p>This function is the main entry of the traffic generator test.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS if tests pass<ul>
<li>XST_FAILURE if fails.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p class="reference">References <a class="el" href="xtrafgen__interrupt__example_8c.html#afb79fd728f1a6cb5493de055332e83a6">XTrafGenInterruptExample()</a>.</p>

</div>
</div>
<a id="afb79fd728f1a6cb5493de055332e83a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afb79fd728f1a6cb5493de055332e83a6">&#9670;&nbsp;</a></span>XTrafGenInterruptExample()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XTrafGenInterruptExample </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_traf_gen.html">XTrafGen</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function demonstrates the usage Traffic Generator It does the following: </p>
<ul>
<li>Set up the output terminal if UART16550 is in the hardware build</li>
<li>Initialize the AXI Traffic Generator device</li>
<li>Initialize Master RAM</li>
<li>Initialize commands and add them to list</li>
<li>Program internal command and parameter RAMs</li>
<li>Start Master Logic</li>
<li>Wait for the master logic to finish</li>
<li>Check for errors</li>
<li>Read Master RAM and verify data</li>
<li>Return test status and exit</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the instance of the <a class="el" href="struct_x_traf_gen.html" title="The XTrafGen driver instance data. ">XTrafGen</a> component. </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is Device ID of the Axi Traffic Generator Device, typically XPAR_&lt;TRAFGEN_instance&gt;_DEVICE_ID value from xparameters.h.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>-XST_SUCCESS to indicate success -XST_FAILURE to indicate failure </dd></dl>

<p class="reference">References <a class="el" href="struct_x_traf_gen___config.html#ac47f34b47fc9fb39c04ac7a57ac58d48">XTrafGen_Config::BaseAddress</a>, <a class="el" href="group__trafgen__v3__2.html#gaaea625b89454268bbbe7f93e309141c4">XTrafGen_AccessMasterRam()</a>, <a class="el" href="group__trafgen__v3__2.html#ga4d40f6d5551836dab49e0d22e8d5e1eb">XTrafGen_CfgInitialize()</a>, and <a class="el" href="group__trafgen__v3__2.html#gacbf906e378777e17e7d68729315993ec">XTrafGen_LookupConfig()</a>.</p>

<p class="reference">Referenced by <a class="el" href="xtrafgen__interrupt__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
